home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Environments / Oberon⁄F™ 1.2 / Preinstalled version / Std / Docu / Cmds (.txt) < prev    next >
Encoding:
Oberon Document  |  1996-03-29  |  9.2 KB  |  142 lines  |  [oODC/obnF]

  1. Documents.StdDocumentDesc
  2. Documents.DocumentDesc
  3. Containers.ViewDesc
  4. Views.ViewDesc
  5. Stores.StoreDesc
  6. Documents.ModelDesc
  7. Containers.ModelDesc
  8. Models.ModelDesc
  9. Stores.ElemDesc
  10. TextViews.StdViewDesc
  11. TextViews.ViewDesc
  12. TextModels.StdModelDesc
  13. TextModels.ModelDesc
  14. TextModels.AttributesDesc
  15. Helvetica
  16. TextRulers.StdRulerDesc
  17. TextRulers.RulerDesc
  18. TextRulers.StdStyleDesc
  19. TextRulers.StyleDesc
  20. TextRulers.AttributesDesc
  21. Helvetica
  22. Helvetica
  23. Helvetica
  24. StdLinks.LinkDesc
  25. StdCmds.OpenDoc('System/Rsrc/Menus')
  26. Helvetica
  27. Helvetica
  28. Helvetica
  29. Helvetica
  30. StdCmds
  31. DEFINITION StdCmds;
  32.     IMPORT Dialog;
  33.         layout: RECORD (Dialog.Interactor)
  34.             wType, hType: INTEGER;
  35.             width, height: REAL;
  36.             Ok: PROCEDURE
  37.         END;
  38.     PROCEDURE CaretGuard (VAR par: Dialog.Par);
  39.     PROCEDURE CloseDialog;
  40.     PROCEDURE CopyGuard (VAR par: Dialog.Par);
  41.     PROCEDURE CutGuard (VAR par: Dialog.Par);
  42.     PROCEDURE DefaultOnDoubleClick (op, from, to: LONGINT);
  43.     PROCEDURE InitLayoutDialog;
  44.     PROCEDURE Open;
  45.     PROCEDURE OpenAux (file, title: ARRAY OF CHAR);
  46.     PROCEDURE OpenAuxDialog (file, title: ARRAY OF CHAR);
  47.     PROCEDURE OpenBrowser (file, title: ARRAY OF CHAR);
  48.     PROCEDURE OpenDoc (file: ARRAY OF CHAR);
  49.     PROCEDURE OpenMask (file, title: ARRAY OF CHAR);
  50.     PROCEDURE OpenToolDialog (file, title: ARRAY OF CHAR);
  51.     PROCEDURE PasteCharGuard (VAR par: Dialog.Par);
  52.     PROCEDURE PasteGuard (VAR par: Dialog.Par);
  53.     PROCEDURE PasteLCharGuard (VAR par: Dialog.Par);
  54.     PROCEDURE PasteView;
  55.     PROCEDURE PasteViewGuard (VAR par: Dialog.Par);
  56.     PROCEDURE SelectionGuard (VAR par: Dialog.Par);
  57.     PROCEDURE SingletonGuard (VAR par: Dialog.Par);
  58. END StdCmds.
  59. StdCmds is a command package which contains many commands and guards which are typically used in menu items (->StdMenuTool) or in hyperlinks (->StdLinks).
  60. The module exports more commands which are not described here; these are the commands and guards for menu items of the Windows standard menus. See the 
  61. Menus
  62.  text for how these commands are used (only on Windows).
  63. VAR layout: RECORD (Dialog.Interactor)
  64. Interactor for root view layout. The size of the outermost view of a document (root view) may be determined in several different ways. Either it is equal to the window size, to the paper size minus the margins defined in the Page
  65. Setup dialog, or to a particular fixed size. The vertical and horizontal directions can be defined independently.
  66. wType, hType: INTEGER    wType IN {0..2}  &  hType IN {0..2}
  67. Determines whether the root view size (horizontical/vertical) has a fixed size (0), the size defined by the Page
  68. Setup dialog (1), or by the window (2).
  69. width, height: REAL    valid iff wType/hType = 1
  70. The root view width/height in centimeters.
  71. Ok: PROCEDURE
  72. Set the selected root view to the interactor values.
  73. PROCEDURE CaretGuard (VAR par: Dialog.Par)
  74. Disables menu item if there is no current caret, i.e. no selection of length 0.
  75. PROCEDURE CloseDialog
  76. This command can be used from within a control to close the window in which the control is embedded. It can only be used as reaction to interactive manipulation of the control, i.e. when the  mouse is clicked in the control or when it receives keyboard input. If the window is a document window and its contents dirty, an error message will be displayed.
  77. must be called in interaction with control    20
  78. PROCEDURE CopyGuard (VAR par: Dialog.Par)
  79. Disables menu item if there is no selection, or if it cannot be copied.
  80. PROCEDURE CutGuard (VAR par: Dialog.Par)
  81. Disables menu item if there is no selection, or if it cannot be cut.
  82. PROCEDURE DefaultOnDoubleClick (op, from, to: LONGINT)
  83. A standard notifier which "clicks" the default button when its control is double-clicked. Typically, this is used in selection boxes or combo boxes.
  84. PROCEDURE HeightGuard (VAR par: Dialog.Par)
  85. Guard command which sets par.readOnly if layout.hType # 0, i.e. if mode is not "fixed".
  86. PROCEDURE InitLayoutDialog
  87. Initialization command for layout interactor.
  88. PROCEDURE Open
  89. Guard: a view was deposited
  90. Takes a deposited view from the global view queue and opens it in a new window.
  91. PROCEDURE OpenAux (file, title: ARRAY OF CHAR)
  92. Takes a file specification of an Oberon/F document and a window title as parameters, and opens an auxiliary window with the specified title. Parameter file must be the path name of a file.
  93. Auxiliary windows are used for displaying temporary editable data.
  94. Example:
  95. "StdCmds.OpenAux('Form/Mod/List', 'List')"
  96. PROCEDURE OpenAuxDialog (file, title: ARRAY OF CHAR)
  97. Takes a file specification of an Oberon/F document and a window title as parameters, and opens a dialog with the specified document. The dialog is opened as an auxiliary window. Parameter file must be the path name of a file.
  98. Auxiliary dialogs are used for self-contained dialogs, i.e. data entry masks or parameter entry masks for commands.
  99. In contrast to OpenAux, OpenAuxDialog turns the opened document into mask mode if it is a container (-> Containers), and opens it into a dialog window if the underlying platform distinguishes between document and dialog windows (e.g. as in Windows).
  100. Example:
  101. "StdCmds.OpenAuxDialog('Form/Rsrc/New', 'New Form')"
  102. PROCEDURE OpenBrowser (file, title: ARRAY OF CHAR)
  103. Takes a file specification of an Oberon/F document and a window title as parameters, and opens the specified document in an auxiliary window. The window contents is not editable, but can be selected. Parameter file must be the path name of a file.
  104. Browser windows are used for displaying documentation. It is possible to select and copy out browser window contents. It is possible to apply find & replace commands, the Info->Interface command, etc.
  105. Example:
  106. "StdCmds.OpenBrowser('Form/Docu/Models', 'Model Docu')"
  107. PROCEDURE OpenDoc (file: ARRAY OF CHAR)
  108. Takes a file specification of an Oberon/F document as parameter, and opens the document in a document window. Parameter file must be the path name of a file. If the same file is already open in an existing document window, this window is brought to the top, instead of opening a new window.
  109. Document windows are used for displaying persistent editable data.
  110. Example:
  111. "StdCmds.OpenDoc('System/Rsrc/Menus')"
  112. PROCEDURE OpenMask (file, title: ARRAY OF CHAR)
  113. Obsolete. Use OpenBrowser instead.
  114. PROCEDURE OpenToolDialog (file, title: ARRAY OF CHAR)
  115. Takes a file specification of an Oberon/F document and a window title as parameters, and opens a dialog with the specified document. The dialog is opened as tool window. Parameter file must be the path name of a file.
  116. Tool dialogs are used for dialogs which operate on document windows beneath them, e.g. a find & replace dialog which operates on a text under it. Otherwise it is identical to OpenAuxDialog.
  117. Example:
  118. "DevInspector.InitDialog; StdCmds.OpenToolDialog('Dev/Rsrc/Inspect', 'Inspect')"
  119. PROCEDURE PasteCharGuard (VAR par: Dialog.Par)
  120. Disables menu item if entering a character is currently not possible.
  121. PROCEDURE PasteGuard (VAR par: Dialog.Par)
  122. Disables menu item if pasting is currently not possible.
  123. PROCEDURE PasteLCharGuard (VAR par: Dialog.Par)
  124. Disables menu item if entering a long character is currently not possible.
  125. PROCEDURE PasteView
  126. Guard: a view was deposited
  127. Takes a deposited view from the global view queue and pastes it to the focus.
  128. PROCEDURE PasteViewGuard (VAR par: Dialog.Par)
  129. Disables menu item if pasting a view is currently not possible.
  130. PROCEDURE SelectionGuard (VAR par: Dialog.Par)
  131. Disables menu item if there is no current selection.
  132. PROCEDURE SingletonGuard (VAR par: Dialog.Par)
  133. Disables menu item if there is no current selection, or if the selection doesn't encompass exactly one embedded view.
  134. PROCEDURE WidthGuard (VAR par: Dialog.Par)
  135. Guard command which sets par.readOnly if layout.wType # 0, i.e. if mode is not "fixed".
  136. TextControllers.StdCtrlDesc
  137. TextControllers.ControllerDesc
  138. Containers.ControllerDesc
  139. Controllers.ControllerDesc
  140. Helvetica
  141. Documents.ControllerDesc
  142.